Security News
CISA Brings KEV Data to GitHub
CISA's KEV data is now on GitHub, offering easier access, API integration, commit history tracking, and automated updates for security teams and researchers.
By Sarah Gooding - Jan 29, 2025
New Case Study:See how Anthropic automated 95% of dependency reviews with Socket.Learn More →
balena-errors
Advanced tools
balena-errors
Balena error collection
Role
The intention of this module is to provide a collection of Error instances to be used by the Balena SDK.
THIS MODULE IS LOW LEVEL AND IS NOT MEANT TO BE USED BY END USERS DIRECTLY.
Unless you know what you're doing, use the Balena SDK instead.
Deprecation - note to developers / contributors
While this module has not been formally deprecated,
we now believe that it is not good practice to add error classes to a separate module like
balena-errors. Instead, error classes should be added to the same module that throws the
errors. The reason is that downstream applications (like the balena CLI) may end up with
multiple versions of balena-errors in the node_modules folder, in order to satisfy
dependencies' own dependencies (e.g. a dependency module requires balena-errors v4, and
another dependency module requires balena-errors v3). When this happens, testing error
instances with instanceof fails: For example, an error class like BalenaExpiredToken
loaded from balena-errors v4 would be considered incompatible (not the same class) as
BalenaExpiredToken loaded from balena-errors v3. And this leads to bugs...
Installation
Install balena-errors by running:
$ npm install --save balena-errors
Documentation
- errors
- ~BalenaTooManyRequests
- ~BalenaInvalidLoginCredentials
- ~BalenaInvalidDeviceType
- ~BalenaDiscontinuedDeviceType
- ~BalenaMalformedToken
- ~BalenaSettingsPermissionError
- ~BalenaSupervisorLockedError
- ~BalenaExpiredToken
- ~BalenaApplicationNotFound
- ~BalenaReleaseNotFound
- ~BalenaOrganizationMembershipRoleNotFound
- ~BalenaApplicationMembershipRoleNotFound
- ~BalenaImageNotFound
- ~BalenaServiceNotFound
- ~BalenaDeviceNotFound
- ~BalenaOrganizationNotFound
- ~BalenaAmbiguousDevice
- ~BalenaAmbiguousApplication
- ~BalenaAmbiguousRelease
- ~BalenaKeyNotFound
- ~BalenaRequestError
- ~BalenaNotLoggedIn
- ~BalenaInvalidParameterError
errors~BalenaTooManyRequests
Kind: inner class of errors
Summary: Balena too many requests
Access: public
new BalenaTooManyRequests(nextValidRequestDate)
Returns: Error - error instance
| Param | Type | Description |
|---|---|---|
| nextValidRequestDate | String | next valid request string date |
Example
throw new errors.BalenaTooManyRequests()
errors~BalenaInvalidLoginCredentials
Kind: inner class of errors
Summary: Balena invalid login credentials
Access: public
errors~BalenaInvalidDeviceType
Kind: inner class of errors
Summary: Balena invalid device type
Access: public
new BalenaInvalidDeviceType(type)
Returns: Error - error instance
| Param | Type | Description |
|---|---|---|
| type | String | device type |
Example
throw new errors.BalenaInvalidDeviceType('raspberry-pi')
errors~BalenaDiscontinuedDeviceType
Kind: inner class of errors
Summary: Balena discontinued device type
Access: public
new BalenaDiscontinuedDeviceType(type)
The device type that you specified is invalid because it is discontinued, and this operation is no longer supported.
Returns: Error - error instance
| Param | Type | Description |
|---|---|---|
| type | String | device type |
Example
throw new errors.BalenaDiscontinuedDeviceType('edge')
errors~BalenaMalformedToken
Kind: inner class of errors
Summary: Balena malformed token
Access: public
new BalenaMalformedToken(token)
Returns: Error - error instance
| Param | Type | Description |
|---|---|---|
| token | String | token |
Example
throw new errors.BalenaMalformedToken('1234')
errors~BalenaSettingsPermissionError
Kind: inner class of errors
Summary: Balena settings permission error
Access: public
new BalenaSettingsPermissionError(error)
Returns: Error - error instance
| Param | Type | Description |
|---|---|---|
| error | Error | usually an EACCESS error |
Example
throw new errors.BalenaSettingsPermissionError()
errors~BalenaSupervisorLockedError
Kind: inner class of errors
Summary: The device supervisor is locked
Access: public
new BalenaSupervisorLockedError(token)
Returns: Error - error instance
| Param | Type | Description |
|---|---|---|
| token | String | token |
Example
throw new errors.BalenaSupervisorLockedError()
errors~BalenaExpiredToken
Kind: inner class of errors
Summary: Balena expired token
Access: public
new BalenaExpiredToken(token)
Returns: Error - error instance
| Param | Type | Description |
|---|---|---|
| token | String | token |
Example
throw new errors.BalenaExpiredToken('1234')
errors~BalenaApplicationNotFound
Kind: inner class of errors
Summary: Balena application not found
Access: public
new BalenaApplicationNotFound(application)
Returns: Error - error instance
| Param | Type | Description |
|---|---|---|
| application | String | Number | application name or id |
Example
throw new errors.BalenaApplicationNotFound('MyApp')
errors~BalenaReleaseNotFound
Kind: inner class of errors
Summary: Balena release not found
Access: public
new BalenaReleaseNotFound(release)
Returns: Error - error instance
| Param | Type | Description |
|---|---|---|
| release | String | Number | release commit or id |
Example
throw new errors.BalenaReleaseNotFound(123)
errors~BalenaOrganizationMembershipRoleNotFound
Kind: inner class of errors
Summary: Balena organization membership role not found
Access: public
new BalenaOrganizationMembershipRoleNotFound(organizationMembershipRole)
Returns: Error - error instance
| Param | Type | Description |
|---|---|---|
| organizationMembershipRole | String | Number | organization membership role name or id |
Example
throw new errors.BalenaOrganizationMembershipRoleNotFound(123)
errors~BalenaApplicationMembershipRoleNotFound
Kind: inner class of errors
Summary: Balena application membership role not found
Access: public
new BalenaApplicationMembershipRoleNotFound(applicationMembershipRole)
Returns: Error - error instance
| Param | Type | Description |
|---|---|---|
| applicationMembershipRole | String | Number | application membership role name or id |
Example
throw new errors.BalenaApplicationMembershipRoleNotFound(123)
errors~BalenaImageNotFound
Kind: inner class of errors
Summary: Balena image not found
Access: public
new BalenaImageNotFound(image)
Returns: Error - error instance
| Param | Type | Description |
|---|---|---|
| image | Number | image id |
Example
throw new errors.BalenaImageNotFound(123)
errors~BalenaServiceNotFound
Kind: inner class of errors
Summary: Balena service not found
Access: public
new BalenaServiceNotFound(service)
Returns: Error - error instance
| Param | Type | Description |
|---|---|---|
| service | String | Number | service name or id |
Example
throw new errors.BalenaServiceNotFound(123)
errors~BalenaDeviceNotFound
Kind: inner class of errors
Summary: Balena device not found
Access: public
new BalenaDeviceNotFound(device)
Returns: Error - error instance
| Param | Type | Description |
|---|---|---|
| device | String | Number | device name or id |
Example
throw new errors.BalenaDeviceNotFound('MyDevice')
errors~BalenaOrganizationNotFound
Kind: inner class of errors
Summary: Balena organization not found
Access: public
new BalenaOrganizationNotFound(organization)
Returns: Error - error instance
| Param | Type | Description |
|---|---|---|
| organization | String | Number | organization name or id |
Example
throw new errors.BalenaOrganizationNotFound('MyOrg')
errors~BalenaAmbiguousDevice
Kind: inner class of errors
Summary: Balena ambiguous device
Access: public
new BalenaAmbiguousDevice(device)
Returns: Error - error instance
| Param | Type | Description |
|---|---|---|
| device | String | Number | device name or id |
Example
throw new errors.BalenaAmbiguousDevice('MyDevice')
errors~BalenaAmbiguousApplication
Kind: inner class of errors
Summary: Balena ambiguous application
Access: public
new BalenaAmbiguousApplication(application)
Returns: Error - error instance
| Param | Type | Description |
|---|---|---|
| application | String | Number | application name or id |
Example
throw new errors.BalenaAmbiguousApplication('MyApp')
errors~BalenaAmbiguousRelease
Kind: inner class of errors
Summary: Balena ambiguous release
Access: public
new BalenaAmbiguousRelease(release)
Returns: Error - error instance
| Param | Type | Description |
|---|---|---|
| release | String | release hash |
Example
throw new errors.BalenaAmbiguousRelease('7cf02a6')
errors~BalenaKeyNotFound
Kind: inner class of errors
Summary: Balena key not found
Access: public
new BalenaKeyNotFound(key)
Returns: Error - error instance
| Param | Type | Description |
|---|---|---|
| key | String | Number | key name, id or value |
Example
throw new errors.BalenaKeyNotFound('MyKey')
errors~BalenaRequestError
Kind: inner class of errors
Summary: Balena request error
Access: public
new BalenaRequestError(body, statusCode, [requestOptions], [responseHeaders])
Returns: Error - error instance
| Param | Type | Description |
|---|---|---|
| body | String | response body |
| statusCode | Number | http status code |
| [requestOptions] | Object | options used to make the request |
| [responseHeaders] | Object | the Headers that were included in the response |
Example
throw new errors.BalenaRequestError('Unauthorized')
errors~BalenaNotLoggedIn
Kind: inner class of errors
Summary: Balena not logged in
Access: public
errors~BalenaInvalidParameterError
Kind: inner class of errors
Summary: Balena invalid parameter
Access: public
Support
If you're having any problem, please raise an issue on GitHub and the Balena team will be happy to help.
Tests
Run the test suite by doing:
$ gulp test
Contribute
- Issue Tracker: github.com/balena-io-modules/balena-errors/issues
- Source Code: github.com/balena-io-modules/balena-errors
Before submitting a PR, please make sure that you include tests, and that coffeelint runs without any warning:
$ gulp lint
License
The project is licensed under the Apache 2.0 license.
v4.9.0
(2023-11-01)
- Add an optional responseHeaders property to BalenaRequestError [Thodoris Greasidis]
FAQs
Collection of Balena JavaScript errors
The npm package balena-errors receives a total of 7,913 weekly downloads. As such, balena-errors popularity was classified as popular.
We found that balena-errors demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Package last updated on 01 Nov 2023
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Related posts
Security News
Opengrep Emerges as Open Source Alternative Amid Semgrep Licensing Controversy
Opengrep forks Semgrep to preserve open source SAST in response to controversial licensing changes.
By Sarah Gooding - Jan 28, 2025
Security News
Node.js EOL Versions CVE Dubbed the "Worst CVE of the Year" by Security Experts
Critics call the Node.js EOL CVE a misuse of the system, sparking debate over CVE standards and the growing noise in vulnerability databases.
By Sarah Gooding - Jan 24, 2025